モデル実行メソッド
モデルを実行するには、application/x-www-form-urlencodedという値を持つContent-Typeヘッダーとともに、アクセストークンを含むAuthorizationヘッダーを提供する必要があります。
実行エンドポイントは、実行の方法を制御するためのリクエストボディ内のParameterを含むPOSTリクエストを受け付けます。必須のフィールドはモデル名とあなたのグループ名で、これらはアカウント作成時に割り当てられ、デフォルトではあなたのメールアドレスになります。これら2つのParameterだけで実行した場合、モデルはEggplant Functionalスクリプトに接続せずにモデルを通るパスを生成します。
Eggplant FunctionalSuiteに接続したい場合は、その接続を確立するためにエージェントを使用する必要があります。これにより、Eggplant AIエンジンはあなたのEggplant Functionalスクリプト に接続し、それらを実行することができます。エージェントで提供したエイリアスをREST API実行リクエストのagentNameParameterとして使用し、あなたのEggplant FunctionalSuiteへのパスをsuiteLocationParameterに入力します。これら2つのParameterは、Eggplant Functionalに接続するために必要です。他のオプションでは、イテレーション数、ログファイル名、ログディレクトリ、シード番号、最大Action数、再生フラグなどを変更することができます。directedTestParameterは、特定のテストケースを実行するために使用することができます。
メソッド
POST -> http://localhost:8000/api/run
ヘッダー
| 名前 | 値 |
|---|---|
| Authorization | bearer <access_token> |
| Content-Type | application/x-www-form-urlencoded |
ボディParameterー
| 名前 | タイプ | 必要 | デフォルト値 | |||
|---|---|---|---|---|---|---|
agentName | Text | いいえ | ||||
bins | 整数 | いいえ | 100 | |||
coverdb | Text | いいえ | ttdb | |||
covertarget | 整数 | いいえ | 1 | |||
directedTest | Text | いいえ | ||||
execute | true/false | いいえ | 真 | |||
group | Text | はい | ||||
iterations | true/false | いいえ | 1 | |||
logdir | Text | いいえ | logs | |||
logfile | Text | いいえ | modelname_seed_date.log | |||
maxActions | 整数 | いいえ | 10000 | |||
modelName | Text | はい | ||||
onerror | テキスト (clean | continue | immediate | debug) | いいえ | clean |
path | Text | いいえ | ||||
replay | 整数 | いいえ | ||||
seed | 整数 | いいえ | ランダム (1-999999) | |||
suiteLocation | Text | いいえ | ||||
verbosity | Text | いいえ | 0x6b00 |
可能なレスポンス
| ステータス | ステータステキスト | 説明 |
|---|---|---|
200 | OK | |
400 | Bad request | 必要なParameterが送信されていません |
401 | 認証されていない | アクセストークンが無効です |
403 | 禁止されています | 使用可能な同時ユーザーライセンスが不足しています |
403 | 禁止されています | 現在のユーザーはリクエストされたモデルへのアクセス権がありません |
レスポンスボディJSON
典型的なレスポンス:
{
"processid": 605546960,
"id": "6632c840-c731-4535-9f3a-890e61f85b04",
"iterations": "1",
"agent": "DAI-Testing"
}
| 名前 | タイプ | 説明 | |
|---|---|---|---|
processid | 整数 | 実行中のプロセスのID。 | |
id | Text | 3600 | 進行状況を確認し、中止するための実行の一意のID。 |
iterations | 整数 | bearer | この実行 のイテレーション数。 |
agent | Text | bearer | 接続されたエージェントの名前。 |